home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d2 / nansi286.arc / NANSI.DOC < prev    next >
Text File  |  1987-07-19  |  8KB  |  185 lines
  1. nansi    - enhanced MS-DOS ansi console driver
  2.  
  3. SYNOPSIS
  4.     Include in \config.sys the line
  5.         device=nansi.sys
  6.  
  7. DESCRIPTION
  8.     Nansi.sys is a console driver which understands ANSI control
  9.     sequences. It has several advantages over ANSI.SYS (the driver
  10.     supplied with DOS):
  11.     1. It supports new escape sequences (see below).
  12.     2. It provides MUCH faster output under certain conditions.
  13.     3. It supports the 43-line mode of the EGA.
  14.     4. The darned bell is now 1/4 second instead of 1/2 second long.
  15.  
  16.     What a console driver does:
  17.     When you, for example, type
  18.         C:> type foo.txt
  19.     COMMAND.COM opens the file foo.txt, reads it, and writes it to
  20.     the console driver, which puts it up on the screen.
  21.  
  22.     Both ansi.sys and nansi.sys use IBM Video BIOS to control the screen.
  23.     However, nansi.sys bypasses BIOS if the screen is in a text mode; this
  24.     allows much faster operation under certain conditions.
  25.  
  26.     While putting text up on the screen, (n)ansi.sys keeps a lookout for
  27.     the escape character (chr(27), known as ESC); this character signals
  28.     the start of a terminal control sequence.
  29.     Terminal control sequences follow the format
  30.         ESC [ param; param; ...; param cmd
  31.     where
  32.         ESC    is the escape character chr$(27).
  33.         [    is the left bracket character.
  34.         param    is an ASCII decimal number, or a string in quotes.
  35.         cmd    is a case-specific letter identifying the command.
  36.     Usually, zero, one, or two parameters are given.  If parameters
  37.     are omitted, they usually default to 1; however, some commands
  38.     (KKR and DKOCT) treat the no-parameter case specially.
  39.     Spaces are not allowed between parameters.
  40.  
  41.     For example, both ESC[1;1H and ESC[H send the cursor to the home
  42.     position (1,1), which is the upper left.
  43.  
  44.     Either single or double quotes may be used to quote a string.
  45.     Each character inside a quoted string is equivalent to one numeric
  46.     parameter.  Quoted strings are normally used only for the Keyboard
  47.     Key Reassignment command.
  48.  
  49. Control Sequences
  50.     The following table lists the sequences understood by nansi.sys.
  51.     Differences between nansi.sys and the standard ansi.sys are marked
  52.     with a vertical bar (|).
  53.  
  54. Cursor Positioning
  55. Short    Long name        Format        Notes
  56. CUP    cursor position        ESC[y;xH    Sets cursor position.
  57. HVP    cursor position        ESC[y;xf    Same as CUP; not recommended.
  58. CUU    cursor up        ESC[nA        n = # of lines to move
  59. CUD    cursor down        ESC[nB
  60. CUF    cursor forward        ESC[nC        n = # of columns to move
  61. CUB    cursor backward        ESC[nD
  62. DSR    Device Status, Report!    ESC[6n        Find out cursor position.
  63. CPR    Cursor Position report    ESC[y;xR    Response to DSR, as if typed.
  64. SCP    Save Cursor Position    ESC[s        Not nestable.
  65. RCP    Restore Cursor Position ESC[u
  66.  
  67. Editing
  68. ED    Erase in Display    ESC[2J    Clears screen.
  69. EL    Erase in Line        ESC[K    Clears to end of line.
  70. IL  |    Insert Lines        ESC[nL    Inserts n blank lines at cursor line.
  71. DL  |    Delete Lines        ESC[nM    Deletes n lines including cursor line.
  72. ICH |    Insert Characters    ESC[n@    Inserts n blank chars at cursor.
  73. DCH |    Delete Characters    ESC[nP    Deletes n chars including cursor char.
  74.  
  75.  
  76. Mode-Setting
  77. SGR    Set Graphics Rendition    ESC[n;n;...nm    See character attribute table.
  78. SM    Set Mode        ESC[=nh        See screen mode table.
  79. RM    Reset Mode        ESC[=nl        See screen mode table.
  80. IBMKKR    Keyboard Key Reass.    ESC["string"p
  81.     The first char of the string gives the key to redefine; the rest
  82.     of the string is the key's new value.
  83.     To specify unprintable chars, give the ASCII value of the char
  84.     outside of quotes, as a normal parameter.
  85.     IBM function keys are two byte strings; see the IBM Basic manual.
  86.     For instance, ESC[0;";dir a:";13;p redefines function key 1 to
  87.     have the value "dir a:" followed by the ENTER key.
  88.       | If no parameters given, all keys are reset to their default values.
  89.  
  90. DKOCT | Output char translate    ESC[n;ny
  91.       | When first char is encountered in output request, it is replaced with
  92.       | the second char.  This might be useful for previewing text before
  93.       | sending it to a printer with a funny print wheel.
  94.       | If no parameters are given, all chars are reset to normal.
  95.  
  96.  
  97. Character Attributes
  98.     The Set Graphics Rendition command is used to select foreground
  99.     and background colors or attributes.
  100.     When you use multiple parameters, they are executed in sequence, and
  101.     the effects are cumulative.
  102.        Attrib code        Value
  103.         0        All attributes off (normal white on black)
  104.         1        Bold
  105.         4        Underline
  106.         5        Blink
  107.         7        Reverse Video
  108.         8        Invisible (but why?)
  109.         30-37        foregnd blk/red/grn/yel/blu/magenta/cyan/white
  110.         40-47        background
  111.  
  112. Screen Modes
  113.     The IBM BIOS supports several video modes; the codes given in the
  114.     BIOS documentation are used as parameters to the Set Mode command.
  115.       | (In bitmap modes, the cursor is simulated with a small blob (^V).)
  116.         Mode Code        Value
  117.         0        text 40x25 Black & White
  118.         1        text 40x25 Color
  119.         2        text 80x25 Black & White
  120.         3        text 80x25 Color
  121.         4        bitmap 320x200 4 bits/pixel
  122.         5        bitmap 320x200 1 bit/pixel
  123.         6        bitmap 640x200 1 bit/pixel
  124.         7        (cursor wrap kludge)
  125.         13 (EGA)    bitmap 320x200 4 bits/pixel ?
  126.         14 (EGA)    bitmap 640x200 4 bits/pixel
  127.         16 (EGA)    bitmap 640x350 4 bits/pixel
  128.     Mode 7 is an unfortunate kludge; Setting mode 7 tells the cursor
  129.     to wrap around to the next line when it passes the end of a line;
  130.     Resetting mode 7 tells the cursor to not wrap, but rather stay put.
  131.       | If your computer has the Enhanced Graphics Adaptor, modes between
  132.       | 8 and 15 are also supported; see the EGA BIOS for info.
  133.       | The EGA also lets you use a shorter character cell in text modes
  134.       | in order to squeeze 43 lines of text out of the 25-line text modes.
  135.       | To enter 43 line mode, set the desired 25-line text mode (0 to 3),
  136.       | then Set Mode 43.  For instance: ESC[=3h ESC[=43h.
  137.       | To exit 43 line mode, set the desired 25-line text mode again.
  138.       | Nansi.sys ignores mode 43 unless there is an EGA on your computer.
  139.  
  140. Faster Output
  141.       | Any program that sets the console to RAW mode, and buffers its
  142.       | output properly, can achieve extremely high screen update speeds in
  143.       | return for giving up the special functions of the keys ^C, ^S, and ^P.
  144.       | See IOCTL in the MS-DOS 3.x Technical Reference for more info.
  145.     Also, a small improvement in speed may be noticed with some
  146.     programs that use the DOS console in normal mode, as this driver
  147.     efficiently implements the (standard but undocumented) INT 29h
  148.     most-favored-device putchar used by DOS.
  149.  
  150. EXAMPLES
  151.     See the file setraw.doc for Macro Assembler, Lattice C,
  152.     and Microsoft C routines for entering and leaving raw mode.
  153.  
  154. BUGS
  155.     Insert and delete character do not work in graphics modes.
  156.     Graphics mode writing is slow.
  157.     The simulated cursor in graphics mode slows down single-char
  158.     writes by a factor of 3; it should be disable-able.
  159.     Does not support erase-to-end-of-screen and other useful functions.
  160.  
  161. Version
  162.     This version, 2.2, created February 1986.  Problems should
  163.     be reported to Daniel Kegel, 1-60 CIT, Pasadena, CA 91126
  164.     (or, after June 1986, 2648 169th Ave SE, Bellevue, Wa. 98008).
  165.     Your suggestions for improvement would be most welcome.
  166.  
  167. NOTE
  168.     This program may be distributed for educational and personal use
  169.     only.  Commercial use is verboten; get in touch with the author.
  170.  
  171. FILES
  172.     nansi.doc    - this file
  173.          sources
  174.     makefile    - shows how to assemble & link
  175.     nansi.asm    - device driver guts
  176.     nansi_d.asm    - definitions
  177.     nansi_p.asm    - ANSI parameter grabber
  178.     nansi_f.asm    - ANSI function handlers
  179.     nansi_i.asm    - device driver init routine
  180.         examples
  181.     setraw.asm    - for assembly programs
  182.     setraw.msc    - for Microsoft C programs
  183.     setraw.lc    - for Lattice C programs
  184.     rawtest.lc    - example for Lattice C only
  185.